Use the List Box nodes to arrange items in scrollable lists. For example, use List Box nodes to create contact lists, album lists in a media player, or car settings lists. While the layout control nodes arrange their items in a static layout, the List Box nodes arrange their items in a list where the user can see only a set number of items at a time. To access more items, the user scrolls the list box. See Layout control nodes.
|
Use the Grid List Box nodes to create scrollable lists of items arranged in a grid. Learn about the Grid List Box nodes >
|
|
Use the Trajectory List Box 3D node to create scrollable lists of items arranged along a trajectory. Learn about the Trajectory List Box 3D nodes >
|
|
Use the List Box Item Container prefabs to change the appearance of the currently selected item in a list box. Learn about the List Box Item Container prefabs >
|
Universal list box properties
To set the size of the area in which the items in a list box are visible, use these properties:
- Layout Height to set the height of the visible area of a Grid List Box or Trajectory List Box 3D node.
- Layout Width to set the width of the visible area of a Grid List Box or Trajectory List Box 3D node.
- Layout Depth to set the depth of the visible area of a Trajectory List Box 3D node.
Selecting an item and defining its selection behavior
You can set which item in a list box is selected and how an item reacts when the user selects it. For example, you can bring the selected item to the center of the list box visible area.
- To set which item in a list box is selected, use the Selected Item Index property. The indexing starts from 0.
- To set a list box to bring an item to the center of the list box area when the user selects that item, use the Selection Behavior property. See Bringing the selected item to the center of a Grid List Box and Using the Trajectory List Box 3D node.
Defining the items for List Box nodes
You can define where the content for list box items comes from and how you want to present that content. For example, you can use an item template which sets the appearance of each item and get the data for the items from a data source. See Using a data source.
- To set the data object which provides the data for the items in a List Box node, use the Items Source property. See Using list data objects.
- To set which prefab template you want a List Box node to use for the items in its list, use the Item Template property. See Using list data objects.
- To share functionality between the items in a list box, use the Item Container Template property. When you set the Item Container Template property, each item in the list box inherits the functionality from the List Box Item Container node. For example, the Item Container Template can contain a state manager which changes the scale of the selected item in the list box. This way you do not need to set the functionality for each item. See Using the List Box Item Container prefabs.
- To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property. The smaller the value you set in the Keep Alive Item Count property, the more working memory you release for other tasks. Note that this may cause a delay of items appearing in the list box if you scroll the list box quickly.
List box triggers
Use the List Box triggers to react when the user interacts with a List Box node. For example, you can set the appearance of a List Box node when the user scrolls that node. See Reacting when the user interacts with a Grid List Box node and Reacting when the user interacts with a Trajectory List Box 3D node.
